string (parameter type)

String parameters are specified with type="string" in the parameter definition:

    {name="MyString",
     type="string",
     default="Initial text"}

String parameters are displayed as a text input field:

../../../_images/ui-string-parameter.png

For a multi line edit field, specify ui={style="multi-line"}:

    {name="MyMultiLineString",
     type="string",
     default="Initial content",
     ui={style="multi-line"}}
../../../_images/ui-multi-line-string-parameter.png

The current value of a string parameter is accessed via self.parameters in execute, which provides a Lua string:

  local myString = self.parameters.MyString

See also